home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / msgvu121.arc / MSGVU121.DOC < prev    next >
Encoding:
Text File  |  1986-04-03  |  23.2 KB  |  592 lines
  1.  
  2.                            MsgVu (Message View)
  3.                          Version 1.2.1, April 1986
  4.                 Copyright (c) 1985, 1986 David C. Briccetti
  5.                             All Rights Reserved
  6.  
  7.  
  8.  
  9. Introduction:
  10.  
  11.     MsgVu is a tool for managing files of messages saved from
  12.     CompuServe, RBBS, and other information utilities and bulletin board
  13.     systems. With MsgVu you can:
  14.  
  15.     o Read messages easily
  16.  
  17.     o Sort messages by subject or message number
  18.  
  19.     o Delete messages you no longer want to keep
  20.  
  21.     o Print messages
  22.  
  23.     o Search for messages containing certain text
  24.  
  25.  
  26. Disclaimer of Warranty:
  27.  
  28.     This software and manual are sold "as is" and without warranties as
  29.     to performance of merchantability or any other warranties whether
  30.     expressed or implied.  Because of the various hardware and software
  31.     environments into which this program may be put, no warranty of
  32.     fitness for a particular purpose is offered.
  33.  
  34.     Good data processing procedure dictates that any program be
  35.     thoroughly tested with non-critical data before relying on it.  The
  36.     user must assume the entire risk of using the program.  Any
  37.     liability of the seller will be limited exclusively to product
  38.     replacement or refund of purchase price.
  39.  
  40.  
  41. System Requirements:
  42.  
  43.     MsgVu requires at least 128KB of user memory, depending on the
  44.     number of messages to be processed concurrently.  The upper limit is
  45.     3100 messages.  A fixed disk and color display are recommended but
  46.     not required.  You may use more than the default buffer space
  47.     ("Buffers=" in the CONFIG.SYS file) to improve performance.  The DOS
  48.     manual describes CONFIG.SYS in detail.
  49.  
  50.  
  51. Invoking MsgVu:
  52.  
  53.     To invoke MsgVu, enter:
  54.  
  55.     MSGVU [infilename] [outfilename] [/H:host] [/M] [/L] [/E] [/C] [/F]
  56.         [/D:datadrive] [/I] [/U[:statsname]] [/P[:P]] [/R] [/S:sortopts]
  57.         [/Vn] [/Y] [/Z]
  58.  
  59.  
  60. MsgVu Command Parameters:
  61.  
  62.     [infilename] - specifies the name of the file containing the
  63.         messages to be indexed.  If you provide this file name, MsgVu
  64.         will automatically index the messages in the file.  Otherwise
  65.         you may use function 1 from the primary menu to index the
  66.         messages.
  67.  
  68.     [outfilename] - specifies the name of the file into which the
  69.         processed messages are to be written.  You may use this
  70.         parameter only if you provide the "infilename" parameter.  If
  71.         you specify both input and output file names, MsgVu will do all
  72.         processing and then end, without requiring any action from you.
  73.         If you don't provide this parameter, you may write out messages
  74.         by using function 5 from the primary menu.
  75.  
  76.     /H:host - MsgVu adapts itself to the electronic communications
  77.         system you are using by way of a parameter file called
  78.         OPTIONS.MSV.  As distributed, this file contains information
  79.         which describes the following systems: CompuServe, Fido, Host,
  80.         PCBoard, RBBS, TCom, and TBBS.  The default host is initially
  81.         set to CIS (CompuServe).  You may use the /H parameter to
  82.         override the default host name.
  83.  
  84.     /M - specifies that MsgVu is not to use color.  If you have a color
  85.         display adapter and monitor installed, MsgVu will use several
  86.         colors.  If you are using a monochrome monitor with a color
  87.         adapter, MsgVu may show varying degrees of intensity rather than
  88.         colors.  If this is not appealing, you may set MsgVu to
  89.         monochrome mode by using this parameter.
  90.  
  91.     /L - requests that MsgVu not use highlighting.
  92.  
  93.     /E - specifies that MsgVu is not to change the screen mode.
  94.         Ordinarily, MsgVu will perform the equivalent of a DOS "MODE 80"
  95.         command to switch those users currently in 40 column mode to 80
  96.         column mode.  If this mode switch negatively affects your
  97.         display, you may use this parameter to disable it.
  98.  
  99.     /C - specifies that MsgVu is not to delete duplicate messages.
  100.         Duplicate messages are defined as those which have the same
  101.         message number.
  102.  
  103.     /F - specifies that MsgVu is to display its index in double column
  104.         mode.  In this mode, the sender and recipient of each message
  105.         will not appear.
  106.  
  107.     /D:datadrive - specifies the drive MsgVu is to use for reading and
  108.         writing data files.  If you don't use this option, MsgVu will
  109.         use the "current drive".
  110.  
  111.     /I - specifies that when you sort messages by subject, MsgVu is to
  112.         ignore the case of the subject.  By default, MsgVu recognizes
  113.         the case of the subject.  If you use this option, sorting by
  114.         subject will take much longer.
  115.  
  116.     /U[:statsname] - enables the user statistics option, allowing the
  117.         display of a bar graph showing user activity, and the generation
  118.         of a statistics file.  You may use primary option 6 to generate
  119.         the bar graph.
  120.  
  121.         To cause the creation of a statistics file, use the ":statsname"
  122.         subparameter.  "statsname" is the name of the file into which
  123.         MsgVu is to write statistics when you exit the program.  Columns
  124.         1 to 40 of each record in the file will contain a user name and
  125.         id right justified.  Following this field will be 12 sets of two
  126.         numbers in each set.  The 12 sets correspond to a maximum of 12
  127.         message sections.  The first number in each set shows the number
  128.         of messages from that user in that section.  The second number
  129.         shows the number of messages to that user in that section.
  130.  
  131.     /P[:P] - controls the handling of the situation when messages are to
  132.         be written to a file which already exists.  By default, Message
  133.         View will append output files.  If "/P" is specified, output
  134.         files will be overwritten.  If "/P:P" is specified, Message View
  135.         will prompt you to select appending or overwriting when you
  136.         write to a file that exists.  The exception to the above is that
  137.         when you write over the input file, an overwrite will always
  138.         occur, even if you specify /p:p.
  139.  
  140.     /R - specifies that after building the message index, the "Process"
  141.         option (F3 from the main menu) is to be automatically invoked.
  142.  
  143.     /S:sortopts - If both input and output file names are specified, the
  144.         automatic sort feature may be invoked.  "sortoptions" is a one
  145.         or two character string which may contain the letters "s" or
  146.         "n".  If the string contains an "s", a sort on subject will take
  147.         place.  If the string contains an "n", a sort on message number
  148.         will be performed.  "/S:NS" will cause a sort by number followed
  149.         by a sort by subject.  "/S:SN" will perform the sorts in the
  150.         reverse order.
  151.  
  152.     /Vn - MsgVu will run in a "windowing" environment such as TopView.
  153.         The width of the window must be 80.  The depth (vertical size)
  154.         may vary from 1 row to 24.  A minimum depth of around 10 is
  155.         recommended.  "n" specifies the number of rows MsgVu is to use.
  156.         If this parameter is not used, the screen depth will be 25.
  157.  
  158.     /Y - causes MsgVu to run without sound.
  159.  
  160.     /Z - disables the "press any key to cancel" function.
  161.  
  162.  
  163.     NOTE: Operands must be separated from one another by a single space.
  164.  
  165.  
  166. MsgVu Command Examples:
  167.  
  168.     MSGVU - invokes MsgVu normally
  169.  
  170.     MSGVU MSGS.IN MSGS.OUT /S:S - reads messages from file MSGS.IN,
  171.     sorts by subject, and then writes them to file MSGS.OUT
  172.  
  173.     MSGVU /H:RBBS - specifies that the messages to be processed come
  174.     from host RBBS
  175.  
  176.     MSGVU /U - invokes MsgVu with the user statistics graph option (F6)
  177.     enabled
  178.  
  179.     MSGVU /R - causes MsgVu to display the index immediately after it is
  180.     built, rather than waiting for you to press F3 from the primary menu
  181.  
  182.  
  183. Operating MsgVu:
  184.  
  185.     Issue the MSGVU command to invoke MsgVu and the main menu will
  186.     appear.  Several options appear on the menu but only the highlighted
  187.     ones are available to you now.
  188.  
  189.  
  190. Building an Index:
  191.  
  192.     In order to process messages, you must first build an index by
  193.     pressing F1.  MsgVu will ask you for the name of the message file
  194.     you want to process.  Enter the name of the file, using a drive
  195.     identifier and path name if necessary.
  196.  
  197.  
  198. Loading a Previously Saved Index:
  199.  
  200.     If you have already built and saved an index, you may skip the above
  201.     step and load the index by pressing F2.  Saving and loading of
  202.     indexes is discussed later.
  203.  
  204.  
  205. Processing Indexed Messages:
  206.  
  207.     Once you have built or loaded an index, you may process the indexed
  208.     messages by pressing F3.
  209.  
  210.     You will see four columns of information.  The first column contains
  211.     the numbers of the messages in the indexed file.  The second column
  212.     lists the subjects.  The third shows who each message is from and
  213.     the last shows whom each message is to.  Notice that the cursor is
  214.     on the first message number and the number is highlighted.
  215.  
  216.  
  217. Moving Through the Index:
  218.  
  219.     You may move the cursor up and down, and you may scroll the index
  220.     with PgUp and PgDn.  You may scroll to the top of the list with
  221.     Ctrl-PgUp, and to the bottom with Ctrl-PgDn.  To move to the top and
  222.     bottom message on the screen, you may use the Home and End keys.
  223.  
  224.     When several contiguous messages have the same subject, they are
  225.     known as a "message group."  You may use Ctrl-F1 and Ctrl-F2 to jump
  226.     to the previous and next groups.
  227.  
  228.  
  229. Function Keys:
  230.  
  231.     There are two sets of function keys in MsgVu.  Set one is active
  232.     initially.  There are 3 keys that both sets have in common.  F2 is
  233.     set to "KEYS", F9 to "READ", and F10 to "EXIT."  Pressing F2 will
  234.     switch sets.
  235.  
  236.  
  237. Key Set One:
  238.  
  239.     The following paragraphs describe the functions available with key
  240.     set one.
  241.  
  242.  
  243. Deleting Messages:
  244.  
  245.     F3 invokes the "simple delete" function.  Press F3 and the message
  246.     the cursor is on will be flagged for deletion.
  247.  
  248.     F4 invokes the "delete group" function.  Position the cursor at the
  249.     first message in the group to be deleted and press F4.  The entire
  250.     group will be flagged for deletion.
  251.  
  252.     F5 is used in conjunction with the Find option.  The "delete found"
  253.     option will flag for deletion all messages highlighted by the Find
  254.     option.  The find option is explained later. This option is
  255.     available only after a find operation has been performed.
  256.  
  257.     If you flagged any messages for deletion with F3, F4, or F5, you may
  258.     unflag them by once again pressing the keys which you used to delete
  259.     them.  For example, if you deleted a message with F3, you may
  260.     undelete it by positioning the cursor on it and pressing F3 again.
  261.  
  262.     Messages flagged for deletion will be deleted only if the indexed
  263.     messages are written to an output file. Writing out messages is
  264.     discussed later.
  265.  
  266.  
  267. Marking Messages for Special Processing:
  268.  
  269.     The F6 (Mark) and F7 (Mark Group) functions are provided so that you
  270.     may select individual messages or groups of messages for processing
  271.     by subsequent options.  Mark is currently used only with the output
  272.     file option (F5 from main menu).  If you have marked any messages,
  273.     then MsgVu will write only those messages to the output file.
  274.     Marking individual and groups of messages is similar to deleting
  275.     them.
  276.  
  277.     Once you write marked messages to an output file, MsgVu removes them
  278.     from marked status and flags them for deletion.  This makes it
  279.     easier for you to write messages to a separate file and delete them
  280.     from the input file.
  281.  
  282.  
  283. Changing a Message's Subject Heading:
  284.  
  285.     Sometimes messages' subjects do not accurately reflect their
  286.     contents.  You may change a subject to a more meaningful one with
  287.     F8.  With the cursor on the message or group of messages you want to
  288.     change, press F8.  Supply the new subject, and then tell MsgVu
  289.     whether you are changing a single message or a group of messages.
  290.     MsgVu will change the subject in the index right away.  When you
  291.     write the message file out, MsgVu will change the subject
  292.     permanently.
  293.  
  294.  
  295. Reading Messages:
  296.  
  297.     F9 is used to read a message.  With the cursor on the message you
  298.     want to read, press F9.  The message will be displayed.
  299.  
  300.  
  301. The Index Window:
  302.  
  303.     While MsgVu displays the text of a message, it may put a window in
  304.     the upper right corner of the screen.  The purpose of the window is
  305.     to help you keep the current message in context, by showing the
  306.     portion of the index which immediately surrounds the current
  307.     message.  The window shows the numbers and subjects of the 2
  308.     preceding and the 2 following messages.
  309.  
  310.  
  311. Moving Through the Index Within the Read Option:
  312.  
  313.     Within the read option, you may use the cursor up and down keys to
  314.     display the previous and next messages.  You may use PgUp and PgDn
  315.     to scroll the messages through the window, one window-full at a
  316.     time.
  317.  
  318.  
  319. Exiting the Read Option:
  320.  
  321.     To exit the Read option, press F10.  This will return you to the
  322.     index.
  323.  
  324.  
  325. Key Set Two:
  326.  
  327.     If you switch to function key set two, these options become
  328.     available:
  329.  
  330.  
  331. Sorting the Index:
  332.  
  333.     You may sort the messages in message number order (F3) or subject
  334.     order (F4).  If you are working with CompuServe files, you may also
  335.     sort in "reply to" order (F5).  The "reply to" sort attempts to put
  336.     the messages in the order in which they appeared in the message
  337.     conversation.
  338.  
  339.  
  340. Positioning the Index:
  341.  
  342.     If the index is sorted in subject order, you may use F6 to position
  343.     it to a certain location.  After pressing F6, you will be prompted
  344.     for a string to locate.  After you provide the string, the screen
  345.     will be scrolled so that the first message whose subject starts with
  346.     that string will be moved to the top of the index display.  For
  347.     example, if you want to position to the first message that starts
  348.     with the letter "F", press F6 and then enter an "F".  The index will
  349.     be positioned so that the first message starting with an "F" will be
  350.     at the top.
  351.  
  352.  
  353. Searching for Text Within Messages:
  354.  
  355.     F7 invokes the Find option.  Press F7 and you will be prompted for a
  356.     string to search for.  Key in a search string and press Enter.
  357.     Stand by while the messages are searched.  When the search is
  358.     finished, messages in which the search string was found will be
  359.     flagged with an "<F>" next to their subjects on the index displays.
  360.  
  361.  
  362. Printing Messages:
  363.  
  364.     You may use F8 to print the current message on the printer.
  365.  
  366.  
  367. Exiting the Process Messages Option:
  368.  
  369.     To exit the Process Messages Option, press F10.  The primary menu
  370.     will appear.
  371.  
  372.  
  373. Saving and Restoring the Index:
  374.  
  375.     If you plan to access a message file over and over without changing
  376.     it, it is a good idea to save its index to disk so you won't have to
  377.     rebuild it each time you access the message file.  "Save Message
  378.     Index" (F4) does this.  This function will ask for the name to be
  379.     given to the index, and then save the index.  Any file with the same
  380.     name will be written over.  Once you have saved an index, you can
  381.     quickly load it whenever the message file it indexes is to be
  382.     accessed, with "Load Message Index" (F2).
  383.  
  384.  
  385. Writing Processed Messages:
  386.  
  387.     After you process messages, you may want to write them to an output
  388.     file.  Press F5 to do this.  After you enter the name of the output
  389.     file, MsgVu will write out the messages in the order in which they
  390.     currently appear in the index.  Any messages marked for deletion
  391.     will not be written out.  Duplicate messages will be skipped.  If
  392.     you have marked any messages, MsgVu will write out only those
  393.     messages.
  394.  
  395.  
  396. User Statistics:
  397.  
  398.     For CompuServe only, if the "/U" option was used, and the index was
  399.     built rather than loaded, user statistics may be displayed by
  400.     pressing F6 from the main menu.  A bar graph will appear showing the
  401.     number of messages to and from each user.  You may see the graph
  402.     sorted by "number of messages from" or "number of messages to."
  403.  
  404.     On color displays, three colors are used in the graph.  Blue
  405.     represents the number of messages from a user, red shows the number
  406.     to a user, and where red and blue overlap, magenta is used.
  407.  
  408.     On monochrome displays, blue, red, and magenta are replaced by the
  409.     graphic characters ASCII 220, 223, and 219, respectively. 220 is a
  410.     half-sized vertical bar residing at the top of the line. 223 is
  411.     similar but sits at the bottom of the line. 219 is a solid bar which
  412.     fills the line.  An appendix in IBM's BASIC manual shows the graphic
  413.     characters.
  414.  
  415.  
  416. Exiting MsgVu:
  417.  
  418.     F10 will exit the primary menu, which terminates MsgVu.  Depending
  419.     on which functions you performed while in MsgVu, you may be asked to
  420.     confirm your exit request.  This is to prevent you from accidentally
  421.     exiting the program after not having saved your work.
  422.  
  423.  
  424. Tailoring MsgVu:
  425.  
  426.     As described in the section "MSGVU COMMAND PARAMETERS" under the
  427.     description of the /H (host) parameter, the OPTIONS.MSV file
  428.     contains parameters which define the host systems with which Message
  429.     View is to be used.  These parameters are explained here by
  430.     examining the ones for CompuServe.
  431.  
  432.     Here is a sample header for a CompuServe special interest group
  433.     message:
  434.  
  435.         #: 123456 S0/General
  436.             05-Mar-86  15:42:22
  437.         Sb: IBM Personal Computer
  438.         Fm: Joe User 74000,1001
  439.         To: Jim Customer 74000,2010
  440.  
  441.     Here are the parameters in OPTIONS.MSV which are used to describe
  442.     CompuServe messages:
  443.  
  444.         SName(CIS)
  445.         MsgTrigger(1,#:)
  446.         NumHeadlines(5)
  447.         MsgNum(1,4,6)
  448.         DateLoc(2,5,9)
  449.         TimeLoc(2,14,8)
  450.         SubjLoc(3,5,35)
  451.         ToLoc(5,5,40)
  452.         FromLoc(4,5,40)
  453.         Colors(3,15,1,0)
  454.         Window(5)
  455.  
  456.     These parameters are described as follows:
  457.  
  458.     SNAME - provides the name of the host system.  You may use any name
  459.     you choose with the following exception: When working with
  460.     CompuServe files you must use the name 'CIS' in order to activate
  461.     the following special features which are available for CompuServe
  462.     only:
  463.  
  464.         Generation of user statistics
  465.  
  466.         Stripping message numbers out of the front of message subjects
  467.         for index display, sorting, marking, and deleting
  468.  
  469.         Highlighting private messages in the index
  470.  
  471.     MSGTRIGGER - tells MsgVu what string to search for to recognize the
  472.     beginning of a message header.  The first value tells what column to
  473.     look in, and the second value contains the string which identifies
  474.     the start of a message.
  475.  
  476.     NUMHEADLINES - specifies the number of lines in the message headers.
  477.  
  478.     MSGNUM - tells MsgVu how to find the message number within the
  479.     message header.  The three values provide the line, column and
  480.     length of the message number field.
  481.  
  482.     DATELOC, TIMELOC, SUBJLOC, TOLOC, and FROMLOC use the same syntax to
  483.     provide the locations of the date, time, subject, "message to" and
  484.     "message from" fields.
  485.  
  486.     COLORS - allows the overriding of several of MsgVu's default colors.
  487.     From 1 to 4 numbers may be specified to select colors.  Foreground
  488.     colors may have values from 0 to 15 and background colors may be
  489.     from 0 to 7. IBM documentation provides a table showing the colors
  490.     associated with these numbers.  The first value specifies the normal
  491.     foreground color.  The next controls the highlight foreground color.
  492.     The third sets the background color, and the last sets the
  493.     background color of the index window.
  494.  
  495.     WINDOW - specifies the number of lines to appear in the message
  496.     reading screen index window.  The window shows the 2 previous and 2
  497.     following message numbers and subjects.  Valid values for this
  498.     parameter are 0 and 5.
  499.  
  500.  
  501. License Information:
  502.  
  503.     This version of MsgVu is shareware and a $20 per copy fee is
  504.     required from anyone using the product beyond an evaluation period.
  505.     Shareware is a method software developers use to distribute their
  506.     products which allows users to evaluate the products in their own
  507.     environments before buying.
  508.  
  509.     A reduced fee is available for organizations who wish to use
  510.     multiple copies of MsgVu.  Those companies may contact the author
  511.     for details.
  512.  
  513.     Please send payments to:
  514.  
  515.         Briccetti & Associates
  516.         1250 Clay Street #303
  517.         San Francisco, CA 94108
  518.  
  519.  
  520. New Developments:
  521.  
  522.     If you'd like to be notified of MsgVu developments, please enclose
  523.     your address with your payment.
  524.  
  525.     New versions of MsgVu will be available on Briccetti & Associates'
  526.     RBBS at 415 885-2575 (1200 bps), and on CompuServe PCS-131.  Dave
  527.     Briccetti's CompuServe ID is 74475,1072.
  528.  
  529.  
  530. Distribution Restrictions:
  531.  
  532.     MsgVu may be copied and distributed to others with the following
  533.     restrictions:
  534.  
  535.         It must be distributed in an unmodified form
  536.  
  537.         It must not be distributed for profit
  538.  
  539.  
  540. Distribution Licensing Agreement:
  541.  
  542.     Anyone wishing to charge people a fee for giving them a copy of
  543.     MsgVu must have the written authorization of the author.  To receive
  544.     such authorization, send this completed application, along with a
  545.     copy of your software library's order form to Dave Briccetti at the
  546.     address shown above.  Include $7 to cover the cost of processing the
  547.     application and of sending you the latest version of MsgVu.  (Fee
  548.     may be waived for non-profit, non-mail-order user groups.)
  549.  
  550.     Name of Organization: ____________________________________
  551.  
  552.     Your Name: _______________________________________________
  553.     Address:   _______________________________________________
  554.                _______________________________________________
  555.  
  556.  
  557. Terms of Distribution:
  558.  
  559.     1. The fee charged may not exceed $7, including postage, mailer and
  560.     any other charges.  If MsgVu is shipped along with other disks, the
  561.     $7 limit includes the charge for the disk plus a pro-rata share of
  562.     the total shipping and handling and other charges.
  563.  
  564.     2. Your library's catalog or listing must state that this program is
  565.     not free, but is copyrighted software that is provided to allow the
  566.     user to evaluate it before paying.
  567.  
  568.     3. The label on the disk should show that this is a demo program for
  569.     which payment is expected on acceptance for use and should show the
  570.     control number.  Labels will be furnished on request.
  571.  
  572.     4. The offering and sale of MsgVu will be stopped at any time the
  573.     author so requests.
  574.  
  575.     5. Copies must be made from the copy of MsgVu sent to you with this
  576.     agreement.  This is required for control purposes.
  577.  
  578.     6. Problems or complaints will be reported to the author for
  579.     resolution.
  580.  
  581.     In return for the right to charge a fee for the distribution of the
  582.     program MsgVu, I agree to comply with the above terms of
  583.     distribution.
  584.  
  585.     Signed,
  586.  
  587.     ______________________________________    ______________
  588.              your signature                        date
  589.  
  590.     __________________________   _________    ______________
  591.          Dave Briccetti          control #         date
  592.